<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QSqlRelation Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">&#160;&#160;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&#160;&#183; <a href="classes.html"><font color="#004faf">All Classes</font></a>&#160;&#183; <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QSqlRelation Class Reference<br /><sup><sup>[<a href="qtsql.html">QtSql</a> module]</sup></sup></h1><p>The QSqlRelation class stores information about an SQL foreign
key. <a href="#details">More...</a></p>

<h3>Methods</h3><ul><li><div class="fn" /><b><a href="qsqlrelation.html#QSqlRelation">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qsqlrelation.html#QSqlRelation-2">__init__</a></b> (<i>self</i>, QString&#160;<i>aTableName</i>, QString&#160;<i>indexCol</i>, QString&#160;<i>displayCol</i>)</li><li><div class="fn" /><b><a href="qsqlrelation.html#QSqlRelation-3">__init__</a></b> (<i>self</i>, QSqlRelation)</li><li><div class="fn" />QString <b><a href="qsqlrelation.html#displayColumn">displayColumn</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qsqlrelation.html#indexColumn">indexColumn</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qsqlrelation.html#isValid">isValid</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qsqlrelation.html#tableName">tableName</a></b> (<i>self</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QSqlRelation class stores information about an SQL foreign
key.</p>
<p>QSqlRelation is a helper class for <a href="qsqlrelationaltablemodel.html">QSqlRelationalTableModel</a>. See
<a href="qsqlrelationaltablemodel.html#setRelation">QSqlRelationalTableModel.setRelation</a>()
and <a href="qsqlrelationaltablemodel.html#relation">QSqlRelationalTableModel.relation</a>()
for details.</p>
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QSqlRelation" />QSqlRelation.__init__ (<i>self</i>)</h3><p>Constructs an invalid <a href="qsqlrelation.html">QSqlRelation</a> object.</p>
<p>For such an object, the <a href="qsqlrelation.html#tableName">tableName</a>(), <a href="qsqlrelation.html#indexColumn">indexColumn</a>(), and <a href="qsqlrelation.html#displayColumn">displayColumn</a>() functions
return an empty string.</p>
<p><b>See also</b> <a href="qsqlrelation.html#isValid">isValid</a>().</p>


<h3 class="fn"><a name="QSqlRelation-2" />QSqlRelation.__init__ (<i>self</i>, QString&#160;<i>aTableName</i>, QString&#160;<i>indexCol</i>, QString&#160;<i>displayCol</i>)</h3><p>Constructs a <a href="qsqlrelation.html">QSqlRelation</a>
object, where <i>tableName</i> is the SQL table name to which a
foreign key refers, <i>indexColumn</i> is the foreign key, and
<i>displayColumn</i> is the field that should be presented to the
user.</p>
<p><b>See also</b> <a href="qsqlrelation.html#tableName">tableName</a>(), <a href="qsqlrelation.html#indexColumn">indexColumn</a>(), and <a href="qsqlrelation.html#displayColumn">displayColumn</a>().</p>


<h3 class="fn"><a name="QSqlRelation-3" />QSqlRelation.__init__ (<i>self</i>, <a href="qsqlrelation.html">QSqlRelation</a>)</h3><h3 class="fn"><a name="displayColumn" />QString QSqlRelation.displayColumn (<i>self</i>)</h3><p>Returns the column from table <a href="qsqlrelation.html#tableName">tableName</a>() that should be
presented to the user instead of a foreign key.</p>


<h3 class="fn"><a name="indexColumn" />QString QSqlRelation.indexColumn (<i>self</i>)</h3><p>Returns the index column from table <a href="qsqlrelation.html#tableName">tableName</a>() to which a foreign
key refers.</p>


<h3 class="fn"><a name="isValid" />bool QSqlRelation.isValid (<i>self</i>)</h3><p>Returns true if the <a href="qsqlrelation.html">QSqlRelation</a>
object is valid; otherwise returns false.</p>


<h3 class="fn"><a name="tableName" />QString QSqlRelation.tableName (<i>self</i>)</h3><p>Returns the name of the table to which a foreign key refers.</p>
<address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt&#160;4.9.1 for X11</td><td align="center" width="50%">Copyright &#169; <a href="http://www.riverbankcomputing.com">Riverbank&#160;Computing&#160;Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2011</td><td align="right" width="25%">Qt&#160;4.8.0</td></tr></table></div></address></body></html>